<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>abstractbubbleplugin.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">abstractbubbleplugin.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Base class for bubble plugins.
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/closure/goog/editor/plugins/abstractbubbleplugin.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">editor/plugins/abstractbubbleplugin.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_editor_plugins_AbstractBubblePlugin.html">
          goog.editor.plugins.AbstractBubblePlugin</a><br/>
        <div class="class-details">Base class for bubble plugins. This is used for to connect user behavior
in the editor to a goog.ui.editor.Bubble UI element that allows
the user to modify the properties of an element on their page (e.g. the alt
text of an image tag).

Subclasses should override the abstract method getBubbleTargetFromSelection()
with code to determine if the current selection should activate the bubble
type. The other abstract method createBubbleContents() should be overriden
with code to create the inside markup of the bubble.  The base class creates
the rest of the bubble.</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.editor.plugins.AbstractBubblePlugin.bubbleFactory_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">bubbleFactory_<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       Factory function that creates a bubble UI component. It takes as parameters
the bubble parent element and the z index to draw the bubble at.
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line114">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.editor.plugins.AbstractBubblePlugin.call"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">call<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line55">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>






  <td>
    <a name="goog.editor.plugins.AbstractBubblePlugin.defaultBubbleFactory_"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">defaultBubbleFactory_<span class="args">(<span class="arg">parent</span>,&nbsp;<span class="arg">zIndex</span>)</span>
        </span>
        &#8658; <div class="fullType"><span class="type"><a href="class_goog_ui_editor_Bubble.html">goog.ui.editor.Bubble</a></span></div>
      </div>


     <div class="entryOverview">
       Default factory function for creating a bubble UI component.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">parent</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/DOM/Element">Element</a></span></div>
        <div class="entryOverview">The parent element for the bubble.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">zIndex</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">The z index to draw the bubble at.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<div class="fullType"><span class="type"><a href="class_goog_ui_editor_Bubble.html">goog.ui.editor.Bubble</a></span></div>&nbsp;
            The new bubble component.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line102">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.editor.plugins.AbstractBubblePlugin.setBubbleFactory"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">setBubbleFactory<span class="args">(<span class="arg">bubbleFactory</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Sets the bubble factory function.
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">bubbleFactory</span>
        : <div class="fullType"><span class="type">function (Element, number): goog.ui.editor.Bubble</span></div>
        <div class="entryOverview">Function that creates a bubble for the given bubble parent element and z index.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line124">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



  <h2>Global Properties</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry protected">
       <td class="access"></td>





  <a name="goog.editor.plugins.AbstractBubblePlugin.DASH_NBSP_STRING"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">DASH_NBSP_STRING</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The constant string used to separate option links.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line91">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.editor.plugins.AbstractBubblePlugin.LINK_CLASSNAME_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">LINK_CLASSNAME_</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The css class name of link elements.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line82">Code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry private">
       <td class="access"></td>





  <a name="goog.editor.plugins.AbstractBubblePlugin.OPTION_LINK_CLASSNAME_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">OPTION_LINK_CLASSNAME_</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span></div>
     </div>


     <div class="entryOverview">
       The css class name of option link elements.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line73">Code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry private">
       <td class="access"></td>





  <a name="goog.editor.plugins.AbstractBubblePlugin.bubbleMap_"></a>

  <td>


     <div class="arg">
        <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.editor.plugins.AbstractBubblePlugin.</span><span class="entryName">bubbleMap_</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Object">Object</a></span>.&lt;<span>?</span>,(<span class="type"><a href="class_goog_ui_editor_Bubble.html">goog.ui.editor.Bubble</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)&gt;<span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
     </div>


     <div class="entryOverview">
       Map from field id to shared bubble object.
     </div>

  </td>


  <td class="view-code">
     <a href="closure_goog_editor_plugins_abstractbubbleplugin.js.source.html#line135">Code &raquo;</a>
  </td>
     </tr>


  </table>
</div>



      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory plugins</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="editor/plugins/abstractbubbleplugin.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
